Public Class EnhancedLog

Properties Detail

• ActionsIncludeMethodNames (Get)

  Public Property Get ActionsIncludeMethodNames As Boolean
  Flag indicating if logged actions should include method names.

• AutoSave (Get)

  Public Property Get AutoSave As Boolean
  Flag indicating if log documents should be automatically saved every time they are updated

• CachedErrorCode (Get)

  Public Property Get CachedErrorCode As Integer
  The most recently cached error code.

• CachedErrorExtended (Get)

  Public Property Get CachedErrorExtended As String
  Extended information about the most recently cached error

• CachedErrorLine (Get)

  Public Property Get CachedErrorLine As Integer
  Error Line from the most recently cached error

• CachedErrorMessage (Get)

  Public Property Get CachedErrorMessage As String
  Error message from the most recently cached error

• CachedErrorMethod (Get)

  Public Property Get CachedErrorMethod As String
  Method in which the most recently cached error was triggered.

• CachedErrorTimestamp (Get)

  Public Property Get CachedErrorTimestamp As String
  Timestamp from the most recently cached error.

• Filepath (Get)

  Public Property Get Filepath As String
  Filepath of the log

• hasActions (Get)

  Public Property Get hasActions As Boolean
  Flag indicates if Actions have been logged

• hasCachedError (Get)

  Public Property Get hasCachedError As Boolean
  Flag indicating if Cached errors exist.

• hasEntries (Get)

  Public Property Get hasEntries As Boolean
  Flag indicating if Entries have been logged.

• hasErrors (Get)

  Public Property Get hasErrors As Boolean
  Flag indicating if Errors have been logged.

• LocalEcho (Get)

  Public Property Get LocalEcho As Boolean
  Flag indicating if logged information should be echoed locally (appearing in the status bar of the client).

• LogActions (Get)

  Public Property Get LogActions As Boolean
  Flag indicating if Actions should be written to the log.

• LogErrors (Get)

  Public Property Get LogErrors As Boolean
  Flag indicating if Errors or Exceptions should be written to the log.

• LogMethodResults (Get)

  Public Property Get LogMethodResults As Boolean
  Flag indicating if Method Results should be written to the log

• LogOutputToNotesLog (Get)

  Public Property Get LogOutputToNotesLog As Boolean
  Flag indicating if logged output should be written to a NotesLog

• LogStackExceptions (Get)

  Public Property Get LogStackExceptions As Boolean

  Flag indicating of Stack Exceptions should be written to the Log when an Exception occurs. **************************************** **************************************** WARNING: This property should only be used in Development or Testing environments ONLY! It is UNSTABLE FOR PRODUCTION as it makes use of an undocumented method which is KNOWN TO CAUSE MEMORY LEAKS. Enabling this property in a production environment will likely CAUSE A SERVER CRASH **************************************** ****************************************

• LogWarnings (Get)

  Public Property Get LogWarnings As Boolean
  Flag indicating of Warnings should be logged

• NumActions (Get)

  Public Property Get NumActions As Long
  Number of Actions that have been logged.

• NumErrors (Get)

  Public Property Get NumErrors As Long
  Number of Exceptions that have been logged.

• OverwriteFile (Get)

  Public Property Get OverwriteFile As Boolean
  Flag indicating if an existing File Log should be overwritten (when opening).

• Parent (Get)

  Public Property Get Parent As NotesSession
  Parent NotesSession of the object.

• ProgramName (Get)

  Public Property Get ProgramName As String
  Name of the Program for the object

• ResumeOnLoggingFailure (Get)

  Public Property Get ResumeOnLoggingFailure As Boolean
  Flag indicating if the object should attempt to resume logging if a failure occurs while logging.

• SendTo (Get)

  Public Property Get SendTo As Variant
  Recipients of a Mail Log (array of Strings)

• Server (Get)

  Public Property Get Server As String
  Name of the Server of a NotesLog

• Subject (Get)

  Public Property Get Subject As String
  Subject of a Mail Log

• TargetDatabase (Get)

  Public Property Get TargetDatabase As NotesDatabase
  Database for a Notes Log

• UserName (Get)

  Public Property Get UserName As NotesName
  User Name in place for the object

• UserNameAbbrev (Get)

  Public Property Get UserNameAbbrev As String
  Abbreviated User Name for the object.

• ActionsIncludeMethodNames (Set)

  Public Property Set ActionsIncludeMethodNames As Boolean
  Flag indicating if logged actions should include method names.

• AutoSave (Set)

  Public Property Set AutoSave As Boolean
  Flag indicating if log documents should be automatically saved every time they are updated

• LocalEcho (Set)

  Public Property Set LocalEcho As Boolean
  Flag indicating if logged information should be echoed locally (appearing in the status bar of the client).

• LogActions (Set)

  Public Property Set LogActions As Boolean
  Flag indicating if Actions should be written to the log.

• LogErrors (Set)

  Public Property Set LogErrors As Boolean
  Flag indicating if Errors or Exceptions should be written to the log.

• LogMethodResults (Set)

  Public Property Set LogMethodResults As Boolean
  Flag indicating if Method Results should be written to the log

• LogOutputToNotesLog (Set)

  Public Property Set LogOutputToNotesLog As Boolean
  Flag indicating if logged output should be written to a NotesLog

• LogStackExceptions (Set)

  Public Property Set LogStackExceptions As Boolean

  Flag indicating of Stack Exceptions should be written to the Log when an Exception occurs. **************************************** **************************************** WARNING: This property should only be used in Development or Testing environments ONLY! It is UNSTABLE FOR PRODUCTION as it makes use of an undocumented method which is KNOWN TO CAUSE MEMORY LEAKS. Enabling this property in a production environment will likely CAUSE A SERVER CRASH **************************************** ****************************************

• LogWarnings (Set)

  Public Property Set LogWarnings As Boolean
  Flag indicating of Warnings should be logged

• OverwriteFile (Set)

  Public Property Set OverwriteFile As Boolean
  Flag indicating if an existing File Log should be overwritten (when opening).

• ProgramName (Set)

  Public Property Set ProgramName As String
  Name of the Program for the object

• ResumeOnLoggingFailure (Set)

  Public Property Set ResumeOnLoggingFailure As Boolean
  Flag indicating if the object should attempt to resume logging if a failure occurs while logging.

• SendTo (Set)

  Public Property Set SendTo As Variant
  Recipients of a Mail Log (array of Strings)

• Subject (Set)

  Public Property Set Subject As String
  Subject of a Mail Log

• UserName (Set)

  Public Property Set UserName As NotesName
  User Name in place for the object

• UserNameAbbrev (Set)

  Public Property Set UserNameAbbrev As String
  Abbreviated User Name for the object.

Methods Detail

• AppendAsDocLink

  Public Function AppendAsDocLink(source As NotesDocument, fieldname As String, linkcomment As String, hotspottext As String) As Boolean
  Appends a DocLink to the log
  idx	Argument	Data Type	Attributes	Comments
  1	source	NotesDocument		Document to be appended
  2	fieldname	String		Name of the field within which the document link should be created.
  3	linkcomment	String		Comment about the link
  4	hotspottext	String		Hotspot text to be displayed in place of a link icon.

• OpenAgentLog

  Public Function OpenAgentLog() As Boolean
  Opens an Agent Log

• OpenFileLog

  Public Function OpenFileLog(path As String) As Boolean
  Opens a File Log
  idx	Argument	Data Type	Attributes	Comments
  1	path	String		Filepath of the File Log

• OpenMailLog

  Public Function OpenMailLog(recipients As Variant, subject As String) As Boolean
  Opens a Mail Log
  idx	Argument	Data Type	Attributes	Comments
  1	recipients	Variant		Array of recipients for the Mail Log
  2	subject	String		Subject line of the Mail Log

• OpenNotesLog

  Public Function OpenNotesLog(server As String, dbfile As String) As Boolean
  Opens a Notes Log
  idx	Argument	Data Type	Attributes	Comments
  1	server	String		Name of the server containing the Notes Log.
  2	dbfile	String		Filepath of the Notes Log

• Save

  Public Function Save(force As Boolean, createResponse As Boolean) As Boolean
  Attempts to save the current log by writing all content to disk.
  idx	Argument	Data Type	Attributes	Comments
  1	force	Boolean		Flag indicating if the log save should be forced in the evnet of a conflict.
  2	createResponse	Boolean		Flag indicating if a conflict document should be created in the event of a save conflict.

• ClearCachedError

  Public Sub ClearCachedError()
  Clears the most recently cached error.

• Close

  Public Sub Close()
  Closes the log

• Delete

  Public Sub Delete()
  Destructor

• LogAction

  Public Sub LogAction(description As String)
  Writes an Action to the log (if LogActions property is True)
  idx	Argument	Data Type	Attributes	Comments
  1	description	String		Text to be written to the log

• LogActionWithLink

  Public Sub LogActionWithLink(description As String, linkTo As Variant, linkComment As String, HotSpotText As String)
  Writes an Action with a link to the log (if LogActions property is True)
  idx	Argument	Data Type	Attributes	Comments
  1	description	String		Text to be written to the log
  2	linkTo	Variant		Element to be linked (NotesDatabase, NotesView, or NotesDocument)
  3	linkComment	String	ByVal	Comment about the linked element
  4	HotSpotText	String	ByVal	Hot Spot Text to be displayed instead of a link icon.

• LogError

  Public Sub LogError(code As Integer, description As String)
  Writes an error to the log (if LogErrors flag is True)
  idx	Argument	Data Type	Attributes	Comments
  1	code	Integer		Error Code
  2	description	String		Error Message

• LogEvent

  Public Sub LogEvent(message As String, queuename As String, eventType As Integer, severity As Integer)
  Sends a Domino® event to the network. @param message$ The message to send to the network. @param queuename$ The name of the queue. Domino picks a queue if you send an empty string (""). @param type% Indicates the kind of event being logged. May be any of the following: EV_ALARM (8) EV_COMM (1) EV_MAIL (3) EV_MISC (6) EV_REPLICA (4) EV_RESOURCE (5) EV_SECURITY (2) EV_SERVER (7) EV_UNKNOWN (0) EV_UPDATE (9) @param severity% Indicates the severity of the event being logged. May be any of the following: SEV_FAILURE (2) SEV_FATAL (1) SEV_NORMAL (5) SEV_WARNING1 (3) SEV_WARNING2 (4)
  idx	Argument	Data Type	Attributes	Comments
  1	message	String		The message to send to the network.
  2	queuename	String		The name of the queue. Domino picks a queue if you send an empty string ("").
  3	eventType	Integer		Indicates the kind of event being logged. May be any of the following: EV_ALARM (8) EV_COMM (1) EV_MAIL (3) EV_MISC (6) EV_REPLICA (4) EV_RESOURCE (5) EV_SECURITY (2) EV_SERVER (7) EV_UNKNOWN (0) EV_UPDATE (9)
  4	severity	Integer		Indicates the severity of the event being logged. May be any of the following: SEV_FAILURE (2) SEV_FATAL (1) SEV_NORMAL (5) SEV_WARNING1 (3) SEV_WARNING2 (4)

• LogException

  Public Sub LogException(code As Integer, errMsg As String, errline As Long, methodname As String, description As String)
  Writes an Exception to the log (if LogErrors property is True).
  idx	Argument	Data Type	Attributes	Comments
  1	code	Integer		Error Code
  2	errMsg	String		Error Message
  3	errline	Long		Line number where the error occurred
  4	methodname	String		Name of the method in which the error occurred.
  5	description	String		Description of the error

• LogExceptionCarrier

  Public Sub LogExceptionCarrier(ec As ExceptionCarrier)
  Writes an Exception to the log (if LogErrors property is True
  idx	Argument	Data Type	Attributes	Comments
  1	ec	ExceptionCarrier		Carrier containing information about the exception.

• LogExceptionWithLink

  Public Sub LogExceptionWithLink(code As Integer, errMsg As String, errline As Long, methodname As String, description As String, linkTo As Variant, linkcomment As String, HotSpotText As String)
  Writes an Exception with a link to the log (if LogErrors property is True).
  idx	Argument	Data Type	Attributes	Comments
  1	code	Integer		Error Code
  2	errMsg	String		Error Message
  3	errline	Long		Line number where the error occurred
  4	methodname	String		Name of the method in which the error occurred.
  5	description	String		Description of the error
  6	linkTo	Variant		Element to be linked (NotesDatabase, NotesView, or NotesDocument)
  7	linkcomment	String	ByVal	Comment about the linked element
  8	HotSpotText	String	ByVal	Hot Spot Text to be displayed instead of a link icon.

• LogExtendedContent

  Public Sub LogExtendedContent(description As String, extendedcontent As String)
  Writes and Action along with Extended Content to the log (if LogActions property is True)
  idx	Argument	Data Type	Attributes	Comments
  1	description	String		Text to be written to the log
  2	extendedcontent	String		Extended content information to be written to the log.

• LogExtendedContentWithLink

  Public Sub LogExtendedContentWithLink(description As String, extendedcontent As String, linkTo As Variant, linkComment As String, HotSpotText As String)
  Writes and Action with a link to the log (if LogActions property is True)
  idx	Argument	Data Type	Attributes	Comments
  1	description	String		Text to be written to the log
  2	extendedcontent	String		Extended content information to be written to the log.
  3	linkTo	Variant		Element to be linked (NotesDatabase, NotesView, or NotesDocument)
  4	linkComment	String	ByVal	Comment about the linked element
  5	HotSpotText	String	ByVal	Hot Spot Text to be displayed instead of a link icon.

• LogMethodResult

  Public Sub LogMethodResult(description As String)
  Writes Method Results to the log (if LogMethodResults property is True)
  idx	Argument	Data Type	Attributes	Comments
  1	description	String		Text to be written to the log

• LogMethodResultWithLink

  Public Sub LogMethodResultWithLink(description As String, linkTo As Variant, linkComment As String, HotSpotText As String)
  Writes Method Results with a link to the log (if LogMethodResults property is True)
  idx	Argument	Data Type	Attributes	Comments
  1	description	String		Text to be written to the log
  2	linkTo	Variant		Element to be linked (NotesDatabase, NotesView, or NotesDocument)
  3	linkComment	String	ByVal	Comment about the linked element
  4	HotSpotText	String	ByVal	Hot Spot Text to be displaed instead of a link icon.

• LogStackTrace

  Public Sub LogStackTrace()
  Writes a stack trace to the log (if LogStackExceptions Property is True) **************************************** **************************************** WARNING - Review LogStackExceptions Property **************************************** ****************************************

• LogWarning

  Public Sub LogWarning(description As String)
  Writes a Warning to the log (if LogWarnings property is True)
  idx	Argument	Data Type	Attributes	Comments
  1	description	String		Text to be written to the log

• LogWarningWithLink

  Public Sub LogWarningWithLink(description As String, linkTo As Variant, linkComment As String, HotSpotText As String)
  Writes a Warning with a link to the log (if LogWarnings property is True)
  idx	Argument	Data Type	Attributes	Comments
  1	description	String		Text to be written to the log
  2	linkTo	Variant		Element to be linked (NotesDatabase, NotesView, or NotesDocument)
  3	linkComment	String	ByVal	Comment about the linked element
  4	HotSpotText	String	ByVal	Hot Spot Text to be displayed instead of a link icon.

• New

  Public Sub New(programName As String)
  Constructor
  idx	Argument	Data Type	Attributes	Comments
  1	programName	String		Name of the Program for the EnhancedLog